Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
@turf/invariant
Advanced tools
Readme
Unwrap a coordinate from a Point Feature, Geometry or a single coordinate.
Parameters
Examples
var pt = turf.point([10, 10]);
var coord = turf.getCoord(pt);
//= [10, 10]
Returns Array<number> coordinates
Unwrap coordinates from a Feature, Geometry Object or an Array
Parameters
Examples
var poly = turf.polygon([[[119.32, -8.7], [119.55, -8.69], [119.51, -8.54], [119.32, -8.7]]]);
var coords = turf.getCoords(poly);
//= [[[119.32, -8.7], [119.55, -8.69], [119.51, -8.54], [119.32, -8.7]]]
Returns Array<any> coordinates
Checks if coordinates contains a number
Parameters
coordinates
Array<any> GeoJSON CoordinatesReturns boolean true if Array contains a number
Enforce expectations about types of GeoJSON objects for Turf.
Parameters
value
GeoJSON any GeoJSON object
type
string expected GeoJSON type
name
string name of calling function
Throws Error if value is not the expected type.
Enforce expectations about types of Feature inputs for Turf. Internally this uses geojsonType to judge geometry types.
Parameters
feature
Feature a feature with an expected geometry type
type
string expected GeoJSON type
name
string name of calling function
Throws Error error if value is not the expected type.
Enforce expectations about types of FeatureCollection inputs for Turf. Internally this uses geojsonType to judge geometry types.
Parameters
featureCollection
FeatureCollection a FeatureCollection for which features will be judged
type
string expected GeoJSON type
name
string name of calling function
Throws Error if value is not the expected type.
Get Geometry from Feature or Geometry Object
Parameters
Examples
var point = {
"type": "Feature",
"properties": {},
"geometry": {
"type": "Point",
"coordinates": [110, 40]
}
}
var geom = turf.getGeom(point)
//={"type": "Point", "coordinates": [110, 40]}
Returns (Geometry | null) GeoJSON Geometry Object
Get Geometry Type from Feature or Geometry Object
Get GeoJSON object's type, Geometry type is prioritize.
Parameters
geojson
GeoJSON GeoJSON objectname
string name of the variable to display in error message (optional, default "geojson"
)Examples
var point = {
"type": "Feature",
"properties": {},
"geometry": {
"type": "Point",
"coordinates": [110, 40]
}
}
var geom = turf.getType(point)
//="Point"
Returns string GeoJSON type
This module is part of the Turfjs project, an open source module collection dedicated to geographic algorithms. It is maintained in the Turfjs/turf repository, where you can create PRs and issues.
Install this module individually:
$ npm install @turf/invariant
Or install the Turf module that includes it as a function:
$ npm install @turf/turf
FAQs
turf invariant module
We found that @turf/invariant demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 7 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.